motoでDynamoDBをモックするときはmock_dynamodbを使用することになったので歴史を振り返ってみた

こんにちは。サービス開発室の武田です。boto3のモックライブラリmotoについて、DynamoDBのAPIについて調べてみました。

#Boto3

#Python

武田隆志

2023.08.23

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

こんにちは。サービス開発室の武田です。

PythonのAWSライブラリといえばboto3ですね。boto3を使用することで、簡単にプログラムからAWSリソースを操作できます。外部APIを使用する際に課題となるのはユニットテストです。Pythonではmotoという、boto3のモッキングライブラリが開発されており、これを使用することでboto3を使用しているプログラムのテストが比較的容易に実行できます。

motoではデコレータを使用してモックを使用します。たとえばDynamoDBのモックを差し込みたい場合、次のように書きます。

@mock_dynamodb2
def test_dynamodb():
  pass

さて、長らくmotoユーザーの間では、DynamoDBをモックするならmock_dynamodb2を使用するのが常識でした。実はv4.0.0でこのAPIは削除され、代わりにmock_dynamodbを使用することになりました。結論としてはこれだけなのですが、このエントリでは、少しこのAPIの変遷について追ってみましょう。

そもそもdynamodbとdynamodb2とは

最新のmotoでは（正確にはv4.0.0以降では）mock_dynamodbというAPIを使用することになったわけですが、そもそもなぜ2種類もあったのでしょうか？

motoの初期実装ではmock_dynamodbだけが存在し、mock_dynamodb2が実装されたのは2014年のことです。

Dynamo v2 no indexes by creyer · Pull Request #69 · getmoto/moto

当時のAWS事情を知っている方はどれくらいいるでしょうか。実は2014年というのは boto3が登場する以前の話 です。

このころはまだbotoという（boto3とは違う）ライブラリが使われていました。そしてbotoでDynamoDBv2というAPIが実装されたようです。motoではこの新しいAPIに対応するため、従来のmock_dynamodbとは別にmock_dynamodb2を実装したという経緯のようです。

mock_dynamodbが対応していたのは古いAPIのため、boto3でモックする場合はmock_dynamodb2を使用するということになったのでしょう。